| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376 |
| /**
* @ngdoc directive
* @name patternfly.filters.component:pfFilterPanel
* @restrict E
*
* @description
* The Filter Panel is opened and closed by clicking on the Filter button. It can contain any HTML desired by
* the application developer. As such, the application developer is repsonsible for constructing the <code>appliedFilters</code> array which is passed to
* the filter results tags.
* The application developer is responsible for filtering items based on the <code>appliedFilters</code> array; both when a
* filter is changed on the panel, or when a filter tag is 'cleared' (by user clicking on 'x' in the filter results tag).
* <br>
*
* @param {object} config configuration settings for the filters:<br/>
* <ul style='list-style-type: none'>
* <li>.appliedFilters - (Array) List of the currently applied filters. Used to render the filter results tags and returned
* in the <code>onFilterChange</code> function where it can be used to filter a set of items.
* <ul style='list-style-type: none'>
* <li>.id - (String) Id for the filter, useful for comparisons
* <li>.title - (String) The title to display for the filter results tag
* <li>.values - (Array) The value(s) to display for the filter results tag. Ie. [title: [value1 x] [value2 x]]
* </ul>
* <li>.resultsCount - (int) The number of results returned after the current applied filters have been applied
* <li>.totalCount - (int) The total number of items before any filters have been applied. The 'm' in the label: 'n' of 'm'
* <li>.resultsLabel - (String) Optional label for the result units. Default is "Results". Ex: "'n' of 'm' Results"
* <li>.onFilterChange - ( function(appliedFilters, changedFilterId, changedFilterValue) ) Function to call when the applied
* filters list changes. Triggered by user clicking on 'x' or 'Clear All Filters' in the filter result tags.
* <code>changedFilterId</code> and <code>changedFilterValue</code> are returned after user clicks on an 'x' in a tag to
* denote which filter and filter value was cleared. <code>changedFilterId</code> and <code>changedFilterValue</code> are
* not returned when 'Clear All Filters' link is clicked.
* </ul>
*
* @example
<example module="patternfly.filters">
<file name="index.html">
<div ng-controller="ViewCtrl" class="row example-container">
<div class="col-md-12">
<pf-filter-panel id="exampleFilter" config="filterConfig">
<div class="filter-panel-container">
<input type="text" ng-model="filterPanelModel[0].value"
class="keyword-filter"
placeholder="{{filterPanelModel[0].placeholder}}"
ng-keypress="onKeywordKeyPress($event)"/>
<div class="category" ng-repeat="filter in filterPanelModel" ng-if="!$first">{{filter.title}}
<ul>
<li ng-repeat="value in filter.values">
<input type="checkbox" ng-model="value.selected" ng-change="filterChanged()"/>
<span class="category-option-label">{{value.title}}</span>
</li>
</ul>
</div>
</div>
</pf-filter-panel>
</div>
<hr class="col-md-12">
<div class="col-md-12">
<label class="events-label">Valid Items: </label>
</div>
<div class="col-md-12">
<div class="col-md-12 cfme-row-column">
<div class="row">
<div class="col-xs-3 col-md-2"><b>ID</b></div>
<div class="col-xs-3 col-md-2"><b>Keyword</b></div>
<div class="col-xs-3 col-md-4"><b>Category One</b></div>
<div class="col-sx-3 col-md-4"><b>Category Two</b></div>
</div>
</div>
<div ng-repeat="item in items" class="col-md-12 cfme-row-column">
<div class="row">
<div class="col-xs-3 col-md-2">
<span>{{item.id}}</span>
</div>
<div class="col-xs-3 col-md-2">
<span>{{item.keyword}}</span>
</div>
<div class="col-xs-3 col-md-4">
<span>{{item.categoryOne}}</span>
</div>
<div class="col-xs-3 col-md-4">
<span>{{item.categoryTwo}}</span>
</div>
</div>
</div>
</div>
</div>
</file>
<file name="script.js">
angular.module('patternfly.filters').controller('ViewCtrl', ['$scope',
function ($scope) {
$scope.filterPanelModel = [
{
id: 'keyword',
title: 'Keyword',
placeholder: 'Filter by Keyword',
filterType: 'input',
values: []
},
{
id: 'category1',
title: 'Category One',
filterType: 'checkbox',
values: [
{
id: 'val1',
title: 'Value 1',
value: 'Value 1',
selected: false
},
{
id: 'val2',
title: 'Value 2',
value: 'Value 2',
selected: false
},
{
id: 'val3',
title: 'Value 3',
value: 'Value 3',
selected: false
}
]
},
{
id: 'category2',
title: 'Category Two',
filterType: 'checkbox',
values: [
{
id: 'val1',
title: 'Value 1',
value: 'Value 1',
selected: false
},
{
id: 'val2',
title: 'Value 2',
value: 'Value 2',
selected: false
},
{
id: 'val3',
title: 'Value 3',
value: 'Value 3',
selected: false
}
]
}
];
$scope.filtersText = '';
$scope.allItems = [
{
id: "1",
keyword: "Foo",
categoryOne: "Value 1",
categoryTwo: "Value 1"
},
{
id: "2",
keyword: "Bar",
categoryOne: "Value 2",
categoryTwo: "Value 1"
},
{
id: "3",
keyword: "Foo",
categoryOne: "Value 3",
categoryTwo: "Value 1"
},
{
id: "4",
keyword: "Bar",
categoryOne: "Value 1",
categoryTwo: "Value 2"
},
{
id: "5",
keyword: "Foo",
categoryOne: "Value 2",
categoryTwo: "Value 2"
},
{
id: "6",
keyword: "Bar",
categoryOne: "Value 3",
categoryTwo: "Value 2"
},
{
id: "7",
keyword: "Foo",
categoryOne: "Value 1",
categoryTwo: "Value 3"
},
{
id: "8",
keyword: "Bar",
categoryOne: "Value 2",
categoryTwo: "Value 3"
},
{
id: "9",
keyword: "Foo",
categoryOne: "Value 3",
categoryTwo: "Value 3"
}
];
$scope.items = $scope.allItems;
// called when filter cleared by hitting 'x' in filter results tag, or 'Clear All Filters' link
var onFilterChange = function (appliedFilters, changedFilterId, changedFilterValue) {
if (angular.isDefined(changedFilterId) && angular.isDefined(changedFilterValue)) {
updateFilterPanelModel(changedFilterId, changedFilterValue);
} else {
// the 'Clear All Filters' link was clicked
resetFilterPanelModel();
}
// filter items
filterItems(appliedFilters);
};
$scope.filterConfig = {
resultsLabel: "Items",
resultsCount: $scope.items.length,
totalCount: $scope.allItems.length,
appliedFilters: [],
onFilterChange: onFilterChange
};
// called when filter is changed in the filter panel
$scope.filterChanged = function() {
applyFilters();
};
$scope.onKeywordKeyPress = function(keyEvent) {
if (keyEvent.which === 13 && $scope.filterPanelModel[0].value.length > 0) {
var currentKeyword = $scope.filterPanelModel[0].value;
if(!keywordFilterExists(currentKeyword)) {
// store new keywoard filter value in values array
$scope.filterPanelModel[0].values.push(currentKeyword);
applyFilters();
}
// remove the keyword value to show placeholder text
delete $scope.filterPanelModel[0].value;
}
};
var keywordFilterExists = function (keyword) {
return _.some( $scope.filterPanelModel[0].values, function(existingKeyword) {
// case sensitive
// return keyword === existingKeyword;
// case insensitive:
return keyword.toLowerCase() === existingKeyword.toLowerCase();
});
}
var applyFilters = function () {
var newAppliedFilters = [];
_.forEach($scope.filterPanelModel, function(filter) {
var filterValues = [];
if (angular.isDefined(filter.values) && filter.values.length > 0) {
if(filter.filterType === "checkbox") {
// the values of the selected checkboxes are stored in a single new appliedFilter
_.forEach(filter.values, function(value) {
if(value.selected) {
filterValues.push(value.value)
}
});
if (filterValues.length > 0) {
newAppliedFilters.push( createAppliedFilter (filter, filterValues) );
}
} else {
// each keyword value gets a new appliedFilter
_.forEach(filter.values, function(value) {
filterValues = [value];
newAppliedFilters.push( createAppliedFilter (filter, filterValues) );
});
}
}
});
// sets the filter result tags
$scope.filterConfig.appliedFilters = newAppliedFilters;
// filter items
filterItems($scope.filterConfig.appliedFilters);
};
var createAppliedFilter = function(filter, values) {
return {
id: filter.id,
title: filter.title,
values: values
};
};
var updateFilterPanelModel = function (changedFilterId, changedFilterValue) {
var changedFilter = _.find($scope.filterPanelModel, function(f) { return f.id === changedFilterId});
if(changedFilter.filterType === "checkbox") {
// unselect the checkbox
_.find(changedFilter.values, function(v) {return v.value == changedFilterValue}).selected = false;
} else {
// remove keyword from values array
_.remove(changedFilter.values, function(v) {return v == changedFilterValue});
}
};
var resetFilterPanelModel = function () {
_.forEach($scope.filterPanelModel, function(filter) {
if (angular.isDefined(filter.values) && filter.values.length > 0) {
if(filter.filterType === "checkbox") {
// unselect all checkboxes
filter.values.forEach(function (value) {
value.selected = false;
});
} else {
// clear all keyword filter values
filter.values = [];
}
}
});
};
var filterItems = function (filters) {
$scope.items = [];
if (filters && filters.length > 0) {
_.forEach($scope.allItems, function(item) {
if (matchesFilters(item, filters)) {
$scope.items.push(item);
}
});
} else {
$scope.items = $scope.allItems;
}
$scope.filterConfig.resultsCount = $scope.items.length;
};
var matchesFilters = function (item, filters) {
var matches = true;
_.forEach(filters, function(filter) {
if (!matchesFilter(item, filter)) {
matches = false;
return false;
}
});
return matches;
};
var matchesFilter = function (item, filter) {
var match = true;
if (filter.id === 'keyword') {
var re = new RegExp(filter.values[0], 'i');
match = item.keyword.match(re) !== null;
} else if (filter.id === 'category1') {
// values are OR'ed
_.forEach(filter.values, function(value) {
match = item.categoryOne === value;
return !match;
});
} else if (filter.id === 'category2') {
// values are OR'ed
_.forEach(filter.values, function(value) {
match = item.categoryTwo === value;
return !match;
});
}
return match;
};
}
]);
</file>
</example>
*/
|